BBS Toolkit

home *** CD-ROM | disk | FTP | other *** search

/ BBS Toolkit / BBS Toolkit.iso / pc_board / fp11s.zip / FIDOPCB.DOC < prev next >

Wrap

Text File | 1992-01-31 | 33KB | 780 lines

------------------------------------------------------- . OOOOOO oo OO OOOOOO OOOOOO OOOOO . Version: 1.1 . OO OO OO OO OO OO OO . Release: Jan 17 1992 . OOOO OO OOOOOO OOOOOO OOOOOO OO OOOOO . Author : Matjaz Koce . OO OO OO OO OO OO OO OO OO OO . . OO OO OOOOOO OOOOOO OO OOOOOO OOOOOO . (c) MicroArt d.o.o ------------------------------------------------------- 1991-92 . FidoPCB - FidoNet to PCBoard 14.x mail interface . ------------------------------------------------------- Lazy Sysop's rule: "Long manuals are never printed and read completely" -----=- Table of contents -=--------------------------------------- Naming Conventions -=-------------------------------- 1 Distribution File -=--------------------------------- 2 Distribution Rules -=-------------------------------- 2 Contacting the Author -=----------------------------- 2 Shareware -=----------------------------------------- 3 Unregistered Shareware version -=-------------------- 3 Overview -=------------------------------------------ 3 Limitations -=--------------------------------------- 4 First installation steps -=-------------------------- 4 Command line parameters -=--------------------------- 5 Configuration file -=-------------------------------- 7 Lost Mail -=----------------------------------------- 10 Handling NetMail -=---------------------------------- 11 Running a DOOR -=------------------------------------ 12 Areafix -=------------------------------------------- 12 Support and distribution nodes -=-------------------- 12 Copyrights, Trademarks and Warranty -=--------------- 13 End -=----------------------------------------------- 13 -----=- Naming Conventions -=---------------------------------------------- FidoPCB is distributed using the file naming convention of: FPvvb.aaa where 'vv' represents the version such as '13' for version 1.3, '50' for version 5.0. The 'b' refers to a letter code specifying (A)lpha, (B)eta, (R)egistered or (S)hareware release versions. The registered release is distributed as FPvvR.aaa. The final AAA refers to the compression method of distribution file. This may be ARC, ZIP, ARJ or whatever. When referring to this distribution file in the documentation, it will usually be referred to as the distribution archive. FidoPcb 1.1 Page 2 -----=- Distribution File -=----------------------------------------------- The following files should be present within the distribution archive: File Description =========== ======================================================== FIDOPCB.CFG Sample (self describing) configuration file FIDOPCB.DOC The documentation you are reading now FIDOPCB.EXE The executable program FIDOPCB Sample DOOR file FILE_ID.DIZ The description file HISTORY.DOC File describing changes from version to version LOST. PCBoard message base for lost mail LOST.NDX Index file for LOST. MATRIX. PCBoard message base for net mail MATRIX.NDX Index file for MATRIX. RUNFD.BAT Sample Batch used to run FrontDoor, PCBoard and FidoPCB =========== ======================================================== Alpha/Beta versions usually do not include the .DOC files but instead include the HISTORY.DOC file for brief description of changes. Please be sure to read this file if you are working with an alpha or beta version of FidoPCB! -----=- Distribution Rules -=---------------------------------------------- Sysops MAY place 'ZIP Comments' on the FidoPCB distribution archive if necessary. Sysops MAY place additional files (such as 'README.1ST' or 'BBS_AD') ONLY if file names don't conflict with files in distribution archive (see above). Distribution of the alpha, beta, and registered versions is restricted to those systems with specific permission to distribute such. Do not distribute any version of FidoPCB except the unregistered shareware (FPvvS.aaa) version! -----=- Contacting the Author -=------------------------------------------- Problems, questions, and suggestions should be directed to Matjaz Koce: Modem: MicroArt BBS Node 1: +38 66 34 986 [1200-9600] Node 2: +38 66 33 816 [1200-2400] Node 3: +38 66 37 536 [1200-2400] Mail: MicroArt d.o.o. Matjaz Koce Pristaniska 5/I 66000 Koper Slovenija FidoPcb 1.1 Page 3 EchoMail: AdriaNet: Sysops, Shareware, HomeMadeSW EchoConferences FidoNet: FidoPCB, Enet.sysop EchoConferences NetMail: 2:380/100@FidoNet.org 2:333/606@FidoNet.org -----=- Shareware -=------------------------------------------------------- You have probably read statements under the heading "Shareware." I won't bother going through it again. Simply be aware that FidoPCB is Shareware. The registered version has additional features, and that the file REGISTER.DOC contains information and the registration form itself. You can also send me NetMail or leave a comment to sysop on MicroArt BBS. Any and all registered users may download and operate any later 1.x registered and beta versions of MicroArt as desired. The registered and beta versions are always available from MicroArt BBS or other support BBS's (See below). Registration will also give you access to the support conference named FidoPCB to share your experiences with other registered users. In this conference you can also make suggestions, report bugs, et cetera. -----=- Unregistered Shareware version -=---------------------------------- Unregistered version will accept maximum of 20 configured areas. Tear line will also indicate that you are using the unregistered version by placing an '--- FidoPCB [NR]' at the end of every message exported by FidoPCB. There are no other limitations in the unregistered version of FidoPCB. -----=- Overview -=-------------------------------------------------------- FidoPCB is an utility used to import/export FidoNet type messages into PCBoard message base. Messages are transferred between many different BBSes in the FidoNet FTS-2 type packets. FidoPCB features include: - unpacking compressed packets (compression can be ZIP, ARC, ARJ, LHA) - importing .PKT files directly into PCBoard's MSG files without the use of FidoNet style .MSGs. - exporting new messages from PCBoard message base - packing of exported messages - makes MSG file for FrontDoor (send file, hold file) - makes OUT file for BinkleyTerm - multiple AKA's - handles NetMail (private FidoNet mail) in both directions (in/out) - recognizes CRASH, DIRECT, INTL and other FidoNet message flags - handles AreaFix commands (if you are host, they can automatically FidoPcb 1.1 Page 4 add or delete areas) - works on networks, multitaskers and multinode PCBoard with file sharing - works as DOOR (with Fossil driver) All these and many other features are included in FidoPCB! -----=- Limitations -=--------------------------------------------------- As mentioned above, the unregistered version will handle only 20 configured areas. Registered version, instead, will handle 1000 areas or more if needed. Using FILES=20 or more in CONFIG.SYS FidoPCB will be able to process mail for 10 configured nodes (if you are working as HUB or HOST). Next versions will have limitations depending on FILES and available memory. FidoPCB doesn't check how much disk space is available, but please make sure there is at least 1 Megabyte free or more depending on packet sizes. There should be at least 300K of free RAM, mainly to run archivers (PKZIP, PKUNZIP, etc..) FidoPCB will only take messages that are 64k and under. Future versions will accommodate messages of unlimited size. -----=- First installation steps -=--------------------------------------- Within the archive containing FidoPCB you received a sample configuration file (FIDOPCB.CFG). I advice you to use it as an example. You should setup two additional conferences in PCBSetup (Matrix and Lost Mail). They will be described later in this DOC. Also be sure you have correctly described archiver directories in FIDOPCB.CFG or put your directory containing various archivers (PKUNZIP, PKZIP, ARJ...) into your search PATH. Installation is divided into this five steps (fourth is the longest :->): 1) create directory FIDOPCB 2) change current directory to newly created FIDOPCB 3) unzip FPvvb.ZIP : FIDOPCB.EXE - executive code FIDOPCB.CFG - sample configuration file FIDOPCB.DOC - this DOC file RUNFD.BAT - sample BAT file for FrontDoor MATRIX.* - message base and its index LOST.* - message base and its index 4) use text editor to edit configuration file FIDOPCB.CFG (lines should end with LF/CR). Don't use Tabs - chr(9)! 4.1) the configuration file is 'self describing', you can read more about various parameters into this DOC; don't forget to setup all conferences you wrote into configuration file under AREA parameter; you must also go into PCBoard, (J)oin them or run PCBPack to create MSGS and MSGS.NDX message bases. 4.2) copy files LOST and LOST.NDX into directory described with parameter FidoPcb 1.1 Page 5 LOST_MAIL and setup this area in PCBoard as LOST_MAIL (this is not really necessary, but I recommend it.) 4.3) copy files MATRIX and MATRIX.NDX into directory described with parameter NET_MAIL and setup this area in PCBoard as MATRIX or NET_MAIL (this is necessary!) 4.4) run FIDOPCB SET ALL TOP (this will report errors in your configuration if there are any and set all lastread pointers); if there are any errors, read step 4.2 again 4.5) select one area as 'test area' and write into some messages (do not use messages with *Origin line unless you are using FORCE parameter in command line!) 4.6) run FIDOPCB SET 'test area' -1 4.7) run FIDOPCB EXPORT 4.8) check the results in PACKET directory, MAIL directory and FIDOPCB.STA file, if not OK goto 4 5) include FIDOPCB.EXE in your BAT files for events 6) install FidoPCB as DOOR If you are incapable to set up FidoPCB just mail me on my BBS. I'll be there to help you. -----=- Command line parameters -=---------------------------------------- Running FIDOPCB.EXE without parameters or with /? will display all command line parameters on the screen. FidoPCB needs only simple information on the command line to operate. Most of the information is read from the FIDOPCB.CFG file. Command line syntax: FIDOPCB [/?] [command] [area name & number] [switch] /? generates short description of all available commands and switches Command should be on of: EXPORT, IMPORT, TOSS, SET, LIST, STAT Switches are: FORCE, RESET, STRIP, DOOR Commands: EXPORT - exports all new messages (since last execution of FIDOPCB), updates last read pointers IMPORT - looks for new mail packet files on directory FILES and imports them into PCBoard message base, updates last read pointers no matter if there were any messages to export TOSS - exports all new messages, look for new mail packet file on directory FILE, imports messages and updates last read pointers SET - syntax of the SET command is: SET AreaName/ALL Number/Top It sets last read pointer for specified area (AreaName) or all areas if you specify ALL instead of area name. Using parameter Top instead of Number will set last read message to highest (top of message base). You can use negative numbers to set last read pointers back from current value for specified FidoPcb 1.1 Page 6 Number of messages (the Number will be subtracted from the highest (top) message number). If the Number is above the highest message, the highest message number will be used. LIST - syntax of the LIST command is: LIST AreaName/ALL It lists last read pointers and areas type. Using ALL instead of AreaName will show you all areas. STAT - displays statistics of all inbound/outbound mail Switches: DOOR - used with all commands and switches; it works only with Fossil driver installed and with PCBOARD.SYS file RESET - used with command STAT will reset statistic information to 0 STRIP - used with EXPORT, TOSS will convert all characters higher than chr(128) into '*' FORCE - used with EXPORT, TOSS will export messages even if they are containing 'Origin:' line (this 'Origin' line checking is used to avoid sending received messages) There are some samples how to use them: FIDOPCB LIST ALL = will list all areas (name, their lastread pointer and type) FIDOPCB STAT = will show import/export statistics FIDOPCB STAT RESET = will reset statistics for all areas to 0 FIDOPCB SET Net_Mail TOP = will set last read pointer in Matrix to top of the message base FIDOPCB SET ALL -10 = will set all areas last read pointers to (current pointer - 10) FIDOPCB SET FIDOTEST 1 = will set lastread pointer in area FIDOTEST to 1 FIDOPCB TOSS STRIP = will export all new messages into PKT files, look for MO?, TH?... and import them into PCBoard, route messages in PKT to other nodes as defined in FIDOPCB.CFG, all characters in messages from PCBoard greater than 'Ç' are changed into '*' FIDOPCB EXPORT FORCE = will export all new messages into PKT files. Messages with * Origin: line into body text, by default are not exported (to FidoPcb 1.1 Page 7 prevent duplicates). Option FORCE forces messages to be exported if they have the Origin line or not. FIDOPCB IMPORT = will look for MO?, TH?... and import them into PCBoard. FIDOPCB TOSS DOOR = exports/imports all messages, output is sent to the modem -----=- Configuration file -=--------------------------------------------- FIDOPCB.CFG contains configuration for FidoPCB. The configuration file can and should be created with a standard text editor such as QEdit or even Edlin. Lines beginning with a semi-colon (";") will be ignored. Each keyword should be specified on a separate line and should have no tabs (chr(9)) between the keyword itself and parameters. Please see the example .CFG file included in this distribution archive for a template to use. Please, don't leave blank lines between separate keywords, because they are ignored and when an error occurs, you'll get a wrong line number indicating this error. Use the semi-colon in such lines. Don't use word processors since they may put some additional information into simple ASCII text. Maximum line length is 512 characters. In future versions a configuration program will be included to ease the configuration process. Valid keywords are: ORIGIN, TAG, SYSOP, NODE, AREA, AREA_MSGS, MAIL, PACKET, WORK, FILE, COMPRESS, FLOW_TYPE, NET_MAIL, LOST_MAIL, AKA, AKA_TAG, USE_AKA, NET_TOSS, INTERFACE, NETWORK, IGNORE_ECHO, ZIP, ARC, ARJ, LZH, UNZIP, UNARC, UNARJ, UNLZH, PCBOARD, FRONTDOOR Most of this keywords have their default values. It is not necessary to use all of them into configuration. Keywords are divided into five groups: directories descriptions, areas and node descriptions, archiver path/names, strings, switches. Some of them are strictly connected: AREA_MSGS should follow AREA keyword SYSOP, COMPRESS, FLOW_TYPE, USE_AKA should follow NODE keyword AKA_TAG should follow AKA SYSOP should follow ORIGIN Directory descriptions: (existing!) directory name (max. 64 characters) FidoPcb 1.1 Page 8 Keyword Description ------------ ------------------------------------------------------------ FILE path to inbound packets (there are put received files) PACKET path to outbound packets (to sent them to other nodes) MAIL path to *.MSG (messages in Front Door) LOST_MAIL path to file LOST and LOST.NDX - message base to import lost mail (from 'not found' areas) NET_MAIL path to file MATRIX and MATRIX.NDX - message base for NetMail remember to put address of receiver in the first line of message when writing messages WORK work drive and direcory to unpack packets (use RAM disk if possible, but be sure to give it enough space) PCBOARD path to file PCBOARD.SYS created by PCBoard when user runs DOOR FRONTDOOR path to FrontDoor main files (FD.EXE...); used to generate FDRESCAN.NOW and FMRESCAN.NOW semaphore files ------------ ------------------------------------------------------------ Example: MAIL c:\front\mail PACKET f:\microart\pcb\fidopcb\packet PCBOARD m:\pcb Switches: they can be ON, OFF, NO, YES, BOTH... First value in table is default value. Keyword Switches Description ------------ ----------- ------------------------------------------------- INTERFACE NONE FidoNet interface program you are using BINKLEY FRONTDOOR NET_TOSS PCBOARD where to process NetMail FRONTDOOR BOTH NETWORK OFF are you using multinode system (for file locking) ON IGNORE_ECHO ON export just messages marked ECHO or all no matter OFF of this flag COMPRESS ZIP compression methods of received/sent packets ARC ARJ LZH FLOWTYPE NORMAL what to do with exported packet: hold, send... HOLD IMMEDIATE CRASH ------------ ----------- ------------------------------------------------- Examples: INTERFACE frontdoor NETWORK off NET_TOSS both FidoPcb 1.1 Page 9 Strings: containing some ASCII data to describe TAGS, SYSOPS... Keyword Description ------------ ------------------------------------------------------------- ORIGIN your node main address (Z:RRR/NNN) TAG this string will be appended on the end of all messages sent under your main address AKA_TAG this string will be appended on the end of all messages sent under your AKA address SYSOP origin (used after ORIGIN) or other nodes sysop name (USED after NODE keyword) ------------ ------------------------------------------------------------- Example: ORIGIN 2:380/100 SYSOP Gregor Rudolf ; AKA 1 2:333/606 AKA_TAG We are the best in Koper, Slovenija (2:333/606) Areas and node description: Multiple parameters on one line are also strictly connected with other keywords (as explained before). Keyword Parameters Description Connection with ------------ ---------- ------------------------------ ------------------- AREA Number area number to connect with AREA_MSGS NODE parameter (from 1 to 20) in shareware version Name area name exactly as in FidoNet areas listing Path path to PCBoard message base Type defining this area as pass trough (NOMAIL - messages are not written into message base) ------------ ---------- ------------------------------ ------------------- NODE Address address of node (Z:RRR/NNN) SYSOP, COMPRESS, Areas area numbers connected to this FLOW_TYPE, USE_AKA node (numbers should match AREA parameters!!!) ------------ ---------- ------------------------------ ------------------- AKA Number aka number to connect with AKA_TAG USE_AKA parameter (from 1 to 10) Address your aka address ------------ ---------- ------------------------------ ------------------- Example: AREA 1 Clipper d:\pcb\clipper AREA_MSGS Clip ; AREA 99 For_node_603 d:\pcb nomail ; NODE 2:333/603 1,99 SYSOP Pietro Budicin COMPRESS zip FLOW_TYPE hold FidoPcb 1.1 Page 10 Archivers paths and names: you should put DOS path to your archiver programs and their names. If you already have your archivers directory into DOS PATH= statement, you can put there just archiver names or don't use this configuration parameter. All keywords beginning with 'UN' should be used to describe unpackers or dearchivers. All necessary parameters and switches (-M, U ...) for archivers are already coded into FIDOPCB.EXE, so you don't need to write them into configuration. Keyword Description Parameters/Switches ---------- ------------------------------ --------------------------- ZIP Used for .ZIP format (PKZIP) -M UNZIP -||- -||- (PKUNZIP) -O ARC Used for .ARC format (PKARC) -R UNARC -||- -||- (PKXARC) -M ARJ Used for .ARJ format (ARJ) M UNARJ -||- -||- (ARJ) E -U LZH Used for .LZH format (LHA) M UNLZH -||- -||- (LHA) E ---------- ------------------------------ --------------------------- Example: ZIP c:\utility\pkunzip.exe <-----+ UNARC m:\archiver\pkxarc.exe | ARJ c:\arj.exe | UNARJ c:\arj.exe | UNLZH d:\lharc\lha.exe | | ZIP pkunzip.exe <--- when you have PATH=c:\utility; -----=- Lost Mail -=------------------------------------------------------ LOST (and it's index, LOST.NDX) is a PCBoard compatible message base containing mail from areas not defined in FIDOPCB.CFG. Occasionally look at it or set up it in PCBSETUP. This is one of indicators if your system is set up correctly on your side and on side of your HUB. Area names defined in FIDOPCB.CFG with the parameter AREA are compared with names found in the mail packet. If FidoPCB founds message with unknown area, puts this message into LOST message base. First line of all messages in LOST will contain AREA: AreaName, so you will be able to locate problems. -----=- Handling NetMail -=----------------------------------------------- MATRIX (and it's index MATRIX.NDX) is PCBoard compatible message base file. You should use it for NetMail messages (private FidoNet messages). If you are using FrontDoor, FidoPCB scans for new MSG files and imports them into MATRIX conference in PCBoard. Compressed Net Mail messages are imported automatically without use of .MSG files. FidoPcb 1.1 Page 11 When you are writing NetMail messages, you must write the address of the receiver's node into the first line, using the format (Z:RRR/NNN.) where: Z = zone number (default is 2) R = region number N = node number. Don't forget brackets; '(' and ')'. FidoPCB will only check this format. MATRIX messages are then transformed into MSG format used by FrontDoor, so you can review them. Their location is MAIL directory in FIDOPCB.CFG. They are routed by FrontDoor. Special flags like HOLD, IMM, CRASH, INTL should be put in brackets on the second line. Example: =================================================== To: ALL Date: 10.10.91 From: Gregor Rudolf Time: 12:13:11 Subj: Just sampling... Read: NO Conf: MATRIX (54) (2:380/101) <- receiver's address (IMM,CRASH) <- special flags This is only a sample message. ===================================================== The meaning of this special flags is explained below: Flag Description ----- ------------------------------------------------------------------- IMM Send message as immidiate CRASH Send crash message HOLD Hold (do not send immediately) message INTL Send message through zone gate. This flag should be present, if you are sending message to other FidoNet zones through zone gate. Do not use this flag, if you want to send message directly to receiver's node. ----- ------------------------------------------------------------------- If you are using NET_TOSS BOTH parameter into configuration file: don't use FM to read messages. This will generate duplicates in your MATRIX conference in PCBoard. I'm still looking for a solution to this unpleasant problem. First line of all received messages will have in the first line written FROM:(address). This will help you to see the sender's address and make your replies more easy. Messages in this conference will also have all ^a lines, containing other information. -----=- Running a FidoPCB as a DOOR -=------------------------------------ FidoPCB can be configured as a DOOR. This will allow you and you users to process mail independently from FrontDoor or other events. FidoPcb 1.1 Page 12 There are two things needed to configure FidoPCB as a DOOR: first, you must have a (BNU, X00 or compatible) Fossil Driver installed on your computer. And the PCBOARD.SYS file generated by PCBoard should be in the directory described with the configuration parameter PCBOARD. The next step is to configure FidoPCB with PCBSETUP (door configuration). File FIDOPCB. is a sample file for the door. Use it as an example (just change drive and directory names). FidoPCB will get all necessary information from PCBOARD.SYS file. If there are any messages to send (Net_mail or File attach of packet), two semaphore files for FrontDoor are generated. This will help you working on a multinode system. On my system only a few users have the security level high enough to run FidoPCB. This can prevent sending dummy NetMail messages and duplicates all over the world. -----=- Areafix -=-------------------------------------------------------- Areafix is active when you are working as HOST or HUB. This will allow all of your configured nodes to list, select and deselect available areas on your node with simple NetMail message. This message should be addressed to Areafix. A "-q" into Subject of message will generate areas listing with marked all selected areas. If you put in message body text area name, this area will be selected. Adding a '-' (minus) before area name will deselect an area. Access to areafix is allowed only to configured nodes. Example: From: Matjaz Potrc, MojsteR BBS (2:380/101) To: Areafix, MicroArt BBS (2:380/100) Subj: -q ------------------------------------------- Clipper -C_Echo -Enet.soft -----=- Support and distribution nodes -=---------------------------------- All support BBS's have FidoPCB FidoNet echoconference. On both, support and distribution nodes you can find the most recent versions of both shareware and beta releases of FidoPCB. If you have any problems just join support conference and wait a while, I and my partners will answer your questions. SUPPORT NODES: Slovenia: 2:380/100 MicroArt BBS +38 66 34986 V32,MNP5 FidoPcb 1.1 Page 13 2:380/101 MojsteR BBS +38 68 23731 V32b,V42b 2:380/103 Brainstorm +38 61 326303 V32,V42b,HST Italy: 2:333/603 Fido_TS_1 +39 40 3783111 V32b,V42b,HST USA: 1:102/815 The Sweet Life PCBoard (818) 882-9058 V32b,V42b,HST -----=- Copyrights, Trademarks and Warranty -=-------------------------- All programs mentioned are copyrighted and/or trademarked by their respective holders. Please refer to each respective program to determine the actual copyright/trademark holder as appropriate or needed. IN NO EVENT WILL MATJAZ KOCE BE RESPONSIBLE IN ANY WAY FOR THE BEHAVIOR OF ANY VERSIONS OF FIDOPCB. IN NO EVENT WILL MATJAZ KOCE AND/OR ANY OTHER PARTY WHO MAY MODIFY AND REDISTRIBUTE FIDOPCB, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY LOST PROFITS, LOST PROFITS, OR OTHER SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS) FIDOPCB, EVEN IF MATJAZ KOCE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, OR FOR ANY CLAIM BY ANY OTHER PARTY. -----=- End -=------------------------------------------------------------ Thanks to: - all beta testers - Gregor Rudolf (who helped me with advices) - Damjan Pavlovec, Matjaz Potrc and Mike Waldron (they helped me with documentation) - Mosaic v1.0 and other PCBoard mailer/tossers (their bugs, slow processing, inabillities,... made me feel bad so much that I decided to write a tosser on my own) Look in the file HISTORY.DOC to see changes from previous versions PLEASE, SUPPORT SHAREWARE! Thank you.